<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GrPPI: Introduction</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.svg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GrPPI
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">Generic and Reusable Parallel Pattern Interface</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="PageDoc"><div class="header">
  <div class="headertitle">
<div class="title">Introduction </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="autotoc_md590"></a>
Thanks</h1>
<p>Thank you for considering contributing to <b>GrPPI</b>. Our aim is to make <b>GrPPI</b> useful for the software community at large. Any kind of contribution is highly appreciated.</p>
<h1><a class="anchor" id="autotoc_md591"></a>
Lincesing your contribution</h1>
<p>By submitting a pull request, you represent that you have the right to license your contribution to University Carlos III of Madrid and the community, and agree by submitting the patch that your contributions are licensed under the <a href="LICENSE.TXT">GrPPI License</a>.</p>
<h1><a class="anchor" id="autotoc_md592"></a>
Why should you read this guideline?</h1>
<p>Following this guideline will help you to keep contact with <b>GrPPI</b> team. This will result in shorter time to process your bug reports, suggestions and pull requests.</p>
<h1><a class="anchor" id="autotoc_md593"></a>
Ways of contributing to GrPPI</h1>
<p>You may contribute in a number of ways, including:</p>
<ul>
<li>Filing bug reports.</li>
<li>Suggesting new features.</li>
<li>Contributing with documentation.</li>
<li>Contributing with with improved implementation of patterns or back ends.</li>
<li>Contributing with unit test cases.</li>
<li>Contributing with sample applications.</li>
</ul>
<h1><a class="anchor" id="autotoc_md594"></a>
Contributing go GrPPI</h1>
<h2><a class="anchor" id="autotoc_md595"></a>
General rules</h2>
<ul>
<li>Please read and follow the GrPPI Code of Conduct before contributing to <b>GrPPI</b>.</li>
</ul>
<p>If you are contributing with documentation:</p>
<ul>
<li>Please, provide improvements as small as possible, as pull requests.</li>
<li>If a change in documentation structure is needed, we prefer that you file a suggestion.</li>
</ul>
<p>If you are contributing with code:</p>
<ul>
<li>Ensure that your pull request passes all unit tests for the set of supported platforms.</li>
<li>For minor issues you can submit a pull request without filing and issue.</li>
<li>For non-trivial issue, please, file an issue that can be discussed before a decision is taken on how to process it.</li>
<li>Software pull requests should be as small as possible and providing only one feature per pull request.</li>
</ul>
<h2><a class="anchor" id="autotoc_md596"></a>
How to file a bug report</h2>
<p>If you find a bug, please create an issue and include the following information:</p>
<ul>
<li>Compiler and version that you used.</li>
<li>Operating system.</li>
<li>Processor and architecture.</li>
<li>Smallest use case that can be used to reproduce the bug.</li>
<li>Results that you obtained and results that you were expecting.</li>
</ul>
<p><b>Important</b>: Please, mark the issue with the label <b>bug</b>.</p>
<h1><a class="anchor" id="autotoc_md597"></a>
How to suggest a new feature</h1>
<p>If you want to suggest a new feature, please create an issue and include the following information:</p>
<ul>
<li>Describe the feature that you are expecting.</li>
</ul>
<p><b>Important</b>: Please, mark the issue with the label <b>feature</b>.</p>
<h2><a class="anchor" id="autotoc_md598"></a>
How to run tests</h2>
<p>Before contributing with code, please, make sure that your code passes all unit tests. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
</small></address>
</body>
</html>
